Motion.StopAxis method

Commands a controlled motion stop and sets an axis to the Stopping state. It aborts any ongoing function execution. While an axis is in the Stopping state, other functions can't move the axis. After the axis has reached velocity zero, the Done field of KsCommandStatus is set to true immediately. To leave the Stopping state and go to Standstill, use Motion.ReleaseAxis.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsCommandStatus StopAxis(
       int Index,
       double Deceleration,
       double Jerk
)

Public Function StopAxis(
       Index As Integer,
       Deceleration As Double,
       Jerk As Double
) As KsCommandStatus

Parameters

Index [in]

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Deceleration [in]

Type: double

A value of the deceleration. The unit is determined by McProfileType. [unit/second²] or [second]

Jerk [in]

Type: double

A value of the jerk. The unit is determined by McProfileType. [unit/second³] or [second]

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Examples

N/A